Repository navigation
DX-3029: Document init commands on every box and public URLs that wake the box - #852
Merged
Merged
Conversation
Init commands were documented only inside keep-alive, which is no longer where they belong: a startup script now runs on every box. They get their own page under Lifecycle, and keep-alive links to it instead of owning it. Corrects three things that were wrong rather than merely incomplete: Public URLs do not expire when a box is paused. They survive sleep and are removed only when the box is deleted. A box restored from a snapshot does not inherit the snapshot's init command. The backend clears the stored script when no init command is supplied, so the caller has to pass it again on the restore. The wake wait is bounded at 30 seconds and then answers 503 with Retry-After, so the page no longer promises the app's response unconditionally. Every request example sets a client timeout longer than the cold-start window, since httpx defaults to five seconds.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
Contributor
|
Docs7 for upstash.com
Commit |
context7
Bot
temporarily deployed
to
Docs7 Preview: DX-3029-wake-on-request-docs
September 21, 2026 12:33
Destroyed
The backend made it unconditional and the option no longer exists anywhere, so the docs describe it as plain behaviour: a request to the URL resumes the box and is held until the port is listening, bounded at 30 seconds with a 503 and Retry-After after that, with auth checked before the wake. The create examples that passed the option, the field on the list output and the warning about reachability are gone. The init commands page keeps its end-to-end example with the option removed from the public URL call.
alitariksahin
changed the title
context7
Bot
temporarily deployed
to
Docs7 Preview: DX-3029-wake-on-request-docs
September 22, 2026 09:12
Destroyed
…f their own A short section under Create a Box in the quickstart now carries what matters: pass initCommand to run a startup script once per container start, on create, resume and snapshot restore; it runs from the workspace root; it can be read, changed or removed later on any box including a paused one; and a snapshot restore does not inherit it. Every link that pointed at the standalone page points there now.
context7
Bot
temporarily deployed
to
Docs7 Preview: DX-3029-wake-on-request-docs
September 22, 2026 10:21
Destroyed
context7
Bot
temporarily deployed
to
Docs7 Preview: DX-3029-wake-on-request-docs
October 6, 2026 12:34
Destroyed
CahidArda
approved these changes
Oct 6, 2026
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Docs side of the public URL work. Backend is merged and live, SDK and CLI are in upstash/box#247, console is in upstash/upstash-console-v2#1529.
Init commands, mentioned where boxes are created
Init commands were documented only inside the keep-alive page, framed as a keep-alive feature, ending with "Init command management is only available when
keepAliveis enabled." That is now false: a startup script runs on every box.Rather than a page of their own, they get a short section under Create a Box in the quickstart: pass
initCommandto run a startup script once per container start, on create, on resume and after a snapshot restore; it runs from the workspace root; it can be read, changed or removed later on any box including a paused one; and a snapshot restore does not inherit it. The keep-alive page keeps its own example and links there.Public URLs and paused boxes
The public URLs page now describes what a URL does while its box is paused: a request resumes the box and is held until the app's port is listening. That wait is bounded at 30 seconds, after which the request gets a 503 with
Retry-After: 5, a self-refreshing page for browsers and a plain 503 otherwise, while the box keeps resuming in the background. Auth is checked before the box is woken. Every request example sets an explicit client timeout longer than the cold-start window, and the Python ones say why, since httpx defaults to five seconds.Corrections, not just additions
Public URLs do not expire on pause. The page said they expire when the box is paused. They survive sleep and are removed only when the box is deleted.
Snapshot restore does not inherit the init command. The backend deletes the stored script when no init command is supplied on restore, so the docs tell callers to pass it again.
Checks
mint broken-linksreports nothing in the Box section; the failures it reports underworkflow/are pre-existing and untouched. No em dashes added. The generated llms files are not regenerated in this branch's latest commit because the checkout carries unrelated local edits; a regeneration on merge will pick everything up.